<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
                      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
    <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
    <title>Extensibilidade - Zend Framework Manual</title>

    <link href="../css/shCore.css" rel="stylesheet" type="text/css" />
    <link href="../css/shThemeDefault.css" rel="stylesheet" type="text/css" />
    <link href="../css/styles.css" media="all" rel="stylesheet" type="text/css" />
</head>
<body>
<h1>Zend Framework</h1>
<h2>Programmer's Reference Guide</h2>
<ul>
    <li><a href="../en/zend.search.lucene.extending.html">Inglês (English)</a></li>
    <li><a href="../pt-br/zend.search.lucene.extending.html">Português Brasileiro (Brazilian Portuguese)</a></li>
</ul>
<table width="100%">
    <tr valign="top">
        <td width="85%">
            <table width="100%">
                <tr>
                    <td width="25%" style="text-align: left;">
                    <a href="zend.search.lucene.charset.html">Conjunto de Caracteres</a>
                    </td>

                    <td width="50%" style="text-align: center;">
                        <div class="up"><span class="up"><a href="zend.search.lucene.html">Zend_Search_Lucene</a></span><br />
                        <span class="home"><a href="manual.html">Guia de Refer&ecirc;ncia do Programador</a></span></div>
                    </td>

                    <td width="25%" style="text-align: right;">
                        <div class="next" style="text-align: right; float: right;"><a href="zend.search.lucene.java-lucene.html">Interoperando com Java Lucene</a></div>
                    </td>
                </tr>
            </table>
<hr />
<div id="zend.search.lucene.extending" class="section"><div class="info"><h1 class="title">Extensibilidade</h1></div>
    

    <div class="section" id="zend.search.lucene.extending.analysis"><div class="info"><h1 class="title">Análise de Texto</h1></div>
        

        <p class="para">
            A classe <span class="classname">Zend_Search_Lucene_Analysis_Analyzer</span> é usada pelo
            indexador para separar em tokens os campos de texto do documento.
        </p>

        <p class="para">
            Os métodos  <span class="methodname">Zend_Search_Lucene_Analysis_Analyzer::getDefault()</span> e
            <code class="code">Zend_Search_Lucene_Analysis_Analyzer::setDefault()</code> são usados para obter e
            setar, respectivamente, o analisador padrão.
        </p>

        <p class="para">
            Você pode atribuir o seu próprio analisador de textos ou selecioná-lo dentre uma lista
            de analisadores pré-definidos:
            <span class="classname">Zend_Search_Lucene_Analysis_Analyzer_Common_Text</span> e
            <span class="classname">Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive</span>
            (padrão). Ambos interpretam os tokens como sequências de letras.
            <span class="classname">Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive</span>
            converte todos os tokens para minúsculas.
        </p>

        <p class="para">
            Para selecionar um analisador:
        </p>

        <pre class="programlisting brush: php">
Zend_Search_Lucene_Analysis_Analyzer::setDefault(
    new Zend_Search_Lucene_Analysis_Analyzer_Common_Text());
...
$index-&gt;addDocument($doc);
</pre>


        <p class="para">
            A classe <span class="classname">Zend_Search_Lucene_Analysis_Analyzer_Common</span> foi
            projetada para ser um antepassado de todos os analisadores definidos pelo usuário. O
            usuário só precisa definir os métodos  <span class="methodname">reset()</span> e
             <span class="methodname">nextToken()</span>, que receberá a string do membro $_input e
            retornará os tokens um por um (um valor <b><tt>NULL</tt></b> indica o fim do
            fluxo).
        </p>

        <p class="para">
            O método  <span class="methodname">nextToken()</span> deve chamar o método
             <span class="methodname">normalize()</span> em cada token. Isso te permite usar filtros de
            token junto com o seu analisador.
        </p>

        <p class="para">
            Aqui está um exemplo de um analisador customizado, que aceita palavras contendo dígitos
            como termos:

            <div class="example" id="zend.search.lucene.extending.analysis.example-1"><div class="info"><p><b>Example #1 Analisador de Texto Customizado</b></p></div>
                

                <pre class="programlisting brush: php">
/**
 * Aqui está um analisador de texto personalizado, que trata as palavras com
 * dígitos como um termo
 */

class My_Analyzer extends Zend_Search_Lucene_Analysis_Analyzer_Common
{
    private $_position;

    /**
     * Reinicia o fluxo do token
     */
    public function reset()
    {
        $this-&gt;_position = 0;
    }

    /**
     * API do fluxo de separação de tokens
     * Obtém o próximo token
     * Retorna null no final do fluxo
     *
     * @return Zend_Search_Lucene_Analysis_Token|null
     */
    public function nextToken()
    {
        if ($this-&gt;_input === null) {
            return null;
        }

        while ($this-&gt;_position &lt; strlen($this-&gt;_input)) {
            // ignora os espaços em branco
            while ($this-&gt;_position &lt; strlen($this-&gt;_input) &amp;&amp;
                   !ctype_alnum( $this-&gt;_input[$this-&gt;_position] )) {
                $this-&gt;_position++;
            }

            $termStartPosition = $this-&gt;_position;

            // lê o token
            while ($this-&gt;_position &lt; strlen($this-&gt;_input) &amp;&amp;
                   ctype_alnum( $this-&gt;_input[$this-&gt;_position] )) {
                $this-&gt;_position++;
            }

            // Token vazio, fim do fluxo.
            if ($this-&gt;_position == $termStartPosition) {
                return null;
            }

            $token = new Zend_Search_Lucene_Analysis_Token(
                                      substr($this-&gt;_input,
                                             $termStartPosition,
                                             $this-&gt;_position -
                                             $termStartPosition),
                                      $termStartPosition,
                                      $this-&gt;_position);
            $token = $this-&gt;normalize($token);
            if ($token !== null) {
                return $token;
            }
            // Continua se o token for ignorado
        }

        return null;
    }
}

Zend_Search_Lucene_Analysis_Analyzer::setDefault(
    new My_Analyzer());
</pre>

            </div>
        </p>
    </div>

    <div class="section" id="zend.search.lucene.extending.filters"><div class="info"><h1 class="title">Filtragem de Tokens</h1></div>
        

        <p class="para">
            O analisador <span class="classname">Zend_Search_Lucene_Analysis_Analyzer_Common</span> também
            oferece um mecanismo de filtragem de token.
        </p>

        <p class="para">
            A classe <span class="classname">Zend_Search_Lucene_Analysis_TokenFilter</span> fornece uma
            interface abstrata para estes filtros. Seus próprios filtros devem estender esta classe,
            diretamente ou indiretamente.
        </p>

        <p class="para">
            Qualquer filtro personalizado deve implementar o método
             <span class="methodname">normalize()</span> que pode transformar o token de entrada ou
            sinalizar que o token corrente deve ser ignorado.
        </p>

        <p class="para">
            Aí estão três filtros já definidos no subpacote de análise:

            <ul class="itemizedlist">
                <li class="listitem">
                    <p class="para">
                        <span class="classname">Zend_Search_Lucene_Analysis_TokenFilter_LowerCase</span>
                    </p>
                </li>

                <li class="listitem">
                    <p class="para">
                        <span class="classname">Zend_Search_Lucene_Analysis_TokenFilter_ShortWords</span>
                    </p>
                </li>

                <li class="listitem">
                    <p class="para">
                        <span class="classname">Zend_Search_Lucene_Analysis_TokenFilter_StopWords</span>
                    </p>
                </li>
            </ul>
        </p>

        <p class="para">
            O filtro <code class="code">LowerCase</code> já é utilizado pelo analisador
            <span class="classname">Zend_Search_Lucene_Analysis_Analyzer_Common_Text_CaseInsensitive</span>
            por padrão.
        </p>

        <p class="para">
            Os filtros <code class="code">ShortWords</code> e <code class="code">StopWords</code> podem ser utilizados com
            analisadores pré-definidos ou personalizados desta forma:
        </p>

        <pre class="programlisting brush: php">
$stopWords = array(&#039;a&#039;, &#039;an&#039;, &#039;at&#039;, &#039;the&#039;, &#039;and&#039;, &#039;or&#039;, &#039;is&#039;, &#039;am&#039;);
$stopWordsFilter =
    new Zend_Search_Lucene_Analysis_TokenFilter_StopWords($stopWords);

$analyzer =
    new Zend_Search_Lucene_Analysis_Analyzer_Common_TextNum_CaseInsensitive();
$analyzer-&gt;addFilter($stopWordsFilter);

Zend_Search_Lucene_Analysis_Analyzer::setDefault($analyzer);
</pre>


        <pre class="programlisting brush: php">
$shortWordsFilter = new Zend_Search_Lucene_Analysis_TokenFilter_ShortWords();

$analyzer =
    new Zend_Search_Lucene_Analysis_Analyzer_Common_TextNum_CaseInsensitive();
$analyzer-&gt;addFilter($shortWordsFilter);

Zend_Search_Lucene_Analysis_Analyzer::setDefault($analyzer);
</pre>


        <p class="para">
            O construtor <span class="classname">Zend_Search_Lucene_Analysis_TokenFilter_StopWords</span>
            recebe uma matriz de stop-words como uma entrada. Mas as stop-words podem também ser
            carregadas a partir de um arquivo:
        </p>

        <pre class="programlisting brush: php">
$stopWordsFilter = new Zend_Search_Lucene_Analysis_TokenFilter_StopWords();
$stopWordsFilter-&gt;loadFromFile($my_stopwords_file);

$analyzer =
   new Zend_Search_Lucene_Analysis_Analyzer_Common_TextNum_CaseInsensitive();
$analyzer-&gt;addFilter($stopWordsFilter);

Zend_Search_Lucene_Analysis_Analyzer::setDefault($analyzer);
</pre>


        <p class="para">
            Este arquivo deve ser um arquivo de texto comum com uma palavra em cada linha. O
            caractere &#039;#&#039; marca uma linha como um comentário.
        </p>

        <p class="para">
            O construtor <span class="classname">Zend_Search_Lucene_Analysis_TokenFilter_ShortWords</span> é
            um argumento opcional. Este é o limite do comprimento de palavra, definido por padrão
            para 2.
        </p>
    </div>

    <div class="section" id="zend.search.lucene.extending.scoring"><div class="info"><h1 class="title">Algoritmos de Pontuação</h1></div>
        

        <p class="para">
            A pontuação de um documento <i>d</i> para uma consulta <i>q</i>
            é definida como segue:
        </p>

        <p class="para">
            <code class="code">score(q,d) = sum( tf(t in d) * idf(t) * getBoost(t.field in d) *
                lengthNorm(t.field in d) ) * coord(q,d) * queryNorm(q)</code>
        </p>

        <p class="para">
            tf(t in d) -  <span class="methodname">Zend_Search_Lucene_Search_Similarity::tf($freq)</span> -
            um fator de pontuação baseado na frequência de um termo ou frase em um documento.
        </p>

        <p class="para">
            idf(t) -  <span class="methodname">Zend_Search_Lucene_Search_Similarity::idf($input,
                $reader)</span> - um fator de pontuação para um termo simples com o índice
            especificado.
        </p>

        <p class="para">
            getBoost(t.field in d) - o fator de reforço para o campo.
        </p>

        <p class="para">
            lengthNorm($term) - O valor de normalização para um campo, dado o número total de termos
            contido nele. Este valor é armazenado junto com o índice. Estes valores, juntamente com
            os campos de reforço, são armazenados em um índice e multiplicados nas pontuações de
            acerto em cada campo, pelo código de busca.
        </p>

        <p class="para">
            Comparações em campos longos são menos precisas, e implementações deste método
            usualmente retornam valores pequenos quando o número de &quot;tokens&quot; é grande, e valores
            grandes quando o número de &quot;tokens&quot; for pequeno.
        </p>

        <p class="para">
            coord(q,d) -  <span class="methodname">Zend_Search_Lucene_Search_Similarity::coord($overlap,
                $maxOverlap)</span> - um fator de pontuação baseado no quociente de todos os
            termos de busca que um documento contém.
        </p>

        <p class="para">
            A existência de uma grande quantidade de termos de busca indica um grau maior de
            comparação. As implementações deste método usualmente retornam valores significativos
            quando a razão entre estes parâmetros é grande e vice versa.
        </p>

        <p class="para">
            queryNorm(q) - o valor de normalização para uma consulta dado a soma das relevâncias ao
            quadrado de cada termo da consulta. Este valor é então multiplicado pela relevância de
            cada item da consulta.
        </p>

        <p class="para">
            Isto não afeta a pontuação, mas a quantidade de tentativas para gerar pontuações em
            comparações entre consultas.
        </p>

        <p class="para">
            O algoritmo de pontuação pode ser customizado pela implementação da sua própria classe
            de similaridade. Para isso crie uma classe descendente de
            <span class="classname">Zend_Search_Lucene_Search_Similarity</span> como mostrado abaixo, então
            use o método
            <span class="classname">Zend_Search_Lucene_Search_Similarity::setDefault($similarity);</span>
            para defini-la como padrão.
        </p>

        <pre class="programlisting brush: php">
class MySimilarity extends Zend_Search_Lucene_Search_Similarity {
    public function lengthNorm($fieldName, $numTerms) {
        return 1.0/sqrt($numTerms);
    }

    public function queryNorm($sumOfSquaredWeights) {
        return 1.0/sqrt($sumOfSquaredWeights);
    }

    public function tf($freq) {
        return sqrt($freq);
    }

    /**
     * It&#039;s not used now. Computes the amount of a sloppy phrase match,
     * based on an edit distance.
     */
    public function sloppyFreq($distance) {
        return 1.0;
    }

    public function idfFreq($docFreq, $numDocs) {
        return log($numDocs/(float)($docFreq+1)) + 1.0;
    }

    public function coord($overlap, $maxOverlap) {
        return $overlap/(float)$maxOverlap;
    }
}

$mySimilarity = new MySimilarity();
Zend_Search_Lucene_Search_Similarity::setDefault($mySimilarity);
</pre>

    </div>

    <div class="section" id="zend.search.lucene.extending.storage"><div class="info"><h1 class="title">Recipientes de Armazenagem</h1></div>
        

        <p class="para">
            A classe abstrata <span class="classname">Zend_Search_Lucene_Storage_Directory</span> define a
            funcionalidade de diretório.
        </p>

        <p class="para">
            O construtor do <span class="classname">Zend_Search_Lucene</span> usa como entrada uma string ou
            um objeto da classe <span class="classname">Zend_Search_Lucene_Storage_Directory</span>.
        </p>

        <p class="para">
            A classe <span class="classname">Zend_Search_Lucene_Storage_Directory_Filesystem</span>
            implementa a funcionalidade de diretório para o sistema de arquivos.
        </p>

        <p class="para">
            Se uma string for usada como entrada para o construtor do
            <span class="classname">Zend_Search_Lucene</span>, então o leitor do índice (um objeto
            <span class="classname">Zend_Search_Lucene</span>) a tratará como um caminho para o sistema de
            arquivos e instanciará um objeto
            <span class="classname">Zend_Search_Lucene_Storage_Directory_Filesystem</span>.
        </p>

        <p class="para">
            Você pode definir a sua própria implementação de diretório estendendo a classe
            <span class="classname">Zend_Search_Lucene_Storage_Directory</span>.
        </p>

        <p class="para">
            Métodos de <span class="classname">Zend_Search_Lucene_Storage_Directory</span>:
        </p>

        <pre class="programlisting brush: php">
abstract class Zend_Search_Lucene_Storage_Directory {
/**
 * Closes the store.
 *
 * @return void
 */
abstract function close();

/**
 * Creates a new, empty file in the directory with the given $filename.
 *
 * @param string $name
 * @return void
 */
abstract function createFile($filename);

/**
 * Removes an existing $filename in the directory.
 *
 * @param string $filename
 * @return void
 */
abstract function deleteFile($filename);

/**
 * Returns true if a file with the given $filename exists.
 *
 * @param string $filename
 * @return boolean
 */
abstract function fileExists($filename);

/**
 * Returns the length of a $filename in the directory.
 *
 * @param string $filename
 * @return integer
 */
abstract function fileLength($filename);

/**
 * Returns the UNIX timestamp $filename was last modified.
 *
 * @param string $filename
 * @return integer
 */
abstract function fileModified($filename);

/**
 * Renames an existing file in the directory.
 *
 * @param string $from
 * @param string $to
 * @return void
 */
abstract function renameFile($from, $to);

/**
 * Sets the modified time of $filename to now.
 *
 * @param string $filename
 * @return void
 */
abstract function touchFile($filename);

/**
 * Returns a Zend_Search_Lucene_Storage_File object for a given
 * $filename in the directory.
 *
 * @param string $filename
 * @return Zend_Search_Lucene_Storage_File
 */
abstract function getFileObject($filename);

}
</pre>


        <p class="para">
            O método  <span class="methodname">getFileObject($filename)</span> de uma instância
            <span class="classname">Zend_Search_Lucene_Storage_Directory</span> retorna um objeto
            <span class="classname">Zend_Search_Lucene_Storage_File</span>.
        </p>

        <p class="para">
            A classe abstrata <span class="classname">Zend_Search_Lucene_Storage_File</span> implementa a
            abstração de arquivo e as primitivas de leitura de arquivos de índice.
        </p>

        <p class="para">
            Se fizer isso, você também terá que estender
            <span class="classname">Zend_Search_Lucene_Storage_File</span> para a sua implementação de
            diretório.
        </p>

        <p class="para">
            Somente dois métodos de <span class="classname">Zend_Search_Lucene_Storage_File</span> devem ser
            substituídos em sua implementação:
        </p>

        <pre class="programlisting brush: php">
class MyFile extends Zend_Search_Lucene_Storage_File {
    /**
     * Sets the file position indicator and advances the file pointer.
     * The new position, measured in bytes from the beginning of the file,
     * is obtained by adding offset to the position specified by whence,
     * whose values are defined as follows:
     * SEEK_SET - Set position equal to offset bytes.
     * SEEK_CUR - Set position to current location plus offset.
     * SEEK_END - Set position to end-of-file plus offset. (To move to
     * a position before the end-of-file, you need to pass a negative value
     * in offset.)
     * Upon success, returns 0; otherwise, returns -1
     *
     * @param integer $offset
     * @param integer $whence
     * @return integer
     */
    public function seek($offset, $whence=SEEK_SET) {
        ...
    }

    /**
     * Read a $length bytes from the file and advance the file pointer.
     *
     * @param integer $length
     * @return string
     */
    protected function _fread($length=1) {
        ...
    }
}
</pre>

    </div>
</div>
        <hr />

            <table width="100%">
                <tr>
                    <td width="25%" style="text-align: left;">
                    <a href="zend.search.lucene.charset.html">Conjunto de Caracteres</a>
                    </td>

                    <td width="50%" style="text-align: center;">
                        <div class="up"><span class="up"><a href="zend.search.lucene.html">Zend_Search_Lucene</a></span><br />
                        <span class="home"><a href="manual.html">Guia de Refer&ecirc;ncia do Programador</a></span></div>
                    </td>

                    <td width="25%" style="text-align: right;">
                        <div class="next" style="text-align: right; float: right;"><a href="zend.search.lucene.java-lucene.html">Interoperando com Java Lucene</a></div>
                    </td>
                </tr>
            </table>
</td>
        <td style="font-size: smaller;" width="15%"> <style type="text/css">
#leftbar {
	float: left;
	width: 186px;
	padding: 5px;
	font-size: smaller;
}
ul.toc {
	margin: 0px 5px 5px 5px;
	padding: 0px;
}
ul.toc li {
	font-size: 85%;
	margin: 1px 0 1px 1px;
	padding: 1px 0 1px 11px;
	list-style-type: none;
	background-repeat: no-repeat;
	background-position: center left;
}
ul.toc li.header {
	font-size: 115%;
	padding: 5px 0px 5px 11px;
	border-bottom: 1px solid #cccccc;
	margin-bottom: 5px;
}
ul.toc li.active {
	font-weight: bold;
}
ul.toc li a {
	text-decoration: none;
}
ul.toc li a:hover {
	text-decoration: underline;
}
</style>
 <ul class="toc">
  <li class="header home"><a href="manual.html">Guia de Refer&ecirc;ncia do Programador</a></li>
  <li class="header up"><a href="manual.html">Guia de Refer&ecirc;ncia do Programador</a></li>
  <li class="header up"><a href="reference.html">Refer&ecirc;ncia do Zend Framework</a></li>
  <li class="header up"><a href="zend.search.lucene.html">Zend_Search_Lucene</a></li>
  <li><a href="zend.search.lucene.overview.html">Resumo</a></li>
  <li><a href="zend.search.lucene.index-creation.html">Construindo &Iacute;ndices</a></li>
  <li><a href="zend.search.lucene.searching.html">Searching an Index</a></li>
  <li><a href="zend.search.lucene.query-language.html">Query Language</a></li>
  <li><a href="zend.search.lucene.query-api.html">Query Construction API</a></li>
  <li><a href="zend.search.lucene.charset.html">Conjunto de Caracteres</a></li>
  <li class="active"><a href="zend.search.lucene.extending.html">Extensibilidade</a></li>
  <li><a href="zend.search.lucene.java-lucene.html">Interoperando com Java Lucene</a></li>
  <li><a href="zend.search.lucene.advanced.html">Avan&ccedil;ado</a></li>
  <li><a href="zend.search.lucene.best-practice.html">Best Practices</a></li>
 </ul>
 </td>
    </tr>
</table>

<script type="text/javascript" src="../js/shCore.js"></script>
<script type="text/javascript" src="../js/shAutoloader.js"></script>
<script type="text/javascript" src="../js/main.js"></script>

</body>
</html>